Vcenter VM Summary

The Vcenter VM Summary schema contains commonly used information about a virtual machine.

JSON Example

{
    "vm": "string",
    "name": "string",
    "power_state": "string",
    "cpu_count": 0,
    "memory_size_mib": 0
}

string

Required

Identifier of the virtual machine.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string

name

Required

Name of the Virtual machine.

string

power_state

Required

Power state of the virtual machine.

For more information see: Vcenter Vm Power State.

integer As int64 As int64

cpu_count

Optional

Number of CPU cores.

This property will be missing or null if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

integer As int64 As int64

memory_size_mib

Optional

Memory size in mebibytes.